Inside Macintosh: QuickTime /

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Functions That Modify Movie Properties / Working With Movie User Data

GetUserDataText

The GetUserDataText function allows your application to retrieve language-tagged text from an item in a user data list. You specify the user data list and item, and the item's type value and language code. The Movie Toolbox retrieves the specified text from the user data item.

pascal OSErr GetUserDataText (UserData theUserData, Handle data, 
                              OSType udType, long index, 
                              short itlRegionTag);

theUserData

Specifies the user data list for this operation. You obtain this list reference by calling the GetMovieUserData, GetTrackUserData, or GetMediaUserData function (described on page 2-215, page 2-216, and page 2-217, respectively).

data

Contains a handle that is to receive the data. The GetUserDataText function resizes this handle as appropriate. Your application must dispose of the handle when you are done with it.

udType

Specifies the item's type value.

index

Specifies the item's index value. This parameter must specify an item in the user data list identified by the parameter theUserData.

itlRegionTag

Specifies the language code of the text to be retrieved. See Inside Macintosh: Text for more information about language and region codes.

ERROR CODES

userDataItemNotFound

-2026

Cannot locate this user data item

Memory Manager errors